<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
<meta content="XdriveAPIError,com.xdrive.json.XdriveAPIError,EXEEDED_COPIES_ERROR,FOLDER_PERMISSION_ERROR,GENERIC_DATABASE_ERROR,HTTP_REQUEST_ERROR,INTERNAL_SERVER_ERROR,INVALID_LOGIN_ERROR,JSON_EXCECTPION,METHOD_NOT_SUPPORTED,SHOW_PERMISSION_ERROR,UPLOAD_FILE_ERROR,errorCode,errorMessage,getErrorMessage" name="keywords">
<title>com.xdrive.json.XdriveAPIError</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'XdriveAPIError - 'Xdrive ActionScript 3 Library'';
				var baseRef = '../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">Xdrive ActionScript 3 Library</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?com/xdrive/json/XdriveAPIError.html&amp;com/xdrive/json/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;XdriveAPIError</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#constantSummary">Constants</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class XdriveAPIError"); titleBar_setSubNav(true,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.xdrive.json</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class XdriveAPIError</td>
</tr>
</table>
<p></p>
  The XdriveAPIError class handles errors from Xdrive JSON API.
  
  XdriveAPIError is the helper class for mapping error codes to more generic and user-friendly
  error messages.  
  <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#errorCode">errorCode</a> : int<div class="summaryTableDescription"></div>
</td><td class="summaryTableOwnerCol">XdriveAPIError</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#errorMessage">errorMessage</a> : String<div class="summaryTableDescription"></div>
</td><td class="summaryTableOwnerCol">XdriveAPIError</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#JSON_EXCECTPION">JSON_EXCECTPION</a> : String = "exceptions"<div class="summaryTableDescription">[static] JSON exception found on return call </div>
</td><td class="summaryTableOwnerCol">XdriveAPIError</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#XdriveAPIError()">XdriveAPIError</a>()</div>
<div class="summaryTableDescription"></div>
</td><td class="summaryTableOwnerCol">XdriveAPIError</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getErrorMessage()">getErrorMessage</a>(errorCode:Number):String</div>
<div class="summaryTableDescription">[static]
   Returns error message by errror number.</div>
</td><td class="summaryTableOwnerCol">XdriveAPIError</td>
</tr>
</table>
</div>
<a name="constantSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Constants</div>
<table id="summaryTableConstant" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#EXEEDED_COPIES_ERROR">EXEEDED_COPIES_ERROR</a> : int = 379<div class="summaryTableDescription">[static] The requested service is temporarily unavailable.</div>
</td><td class="summaryTableOwnerCol">XdriveAPIError</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#FOLDER_PERMISSION_ERROR">FOLDER_PERMISSION_ERROR</a> : int = 364<div class="summaryTableDescription">[static] User does not have permission to edit a folder.</div>
</td><td class="summaryTableOwnerCol">XdriveAPIError</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#GENERIC_DATABASE_ERROR">GENERIC_DATABASE_ERROR</a> : int = 100<div class="summaryTableDescription">[static] Generic database error, error in database call.</div>
</td><td class="summaryTableOwnerCol">XdriveAPIError</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#HTTP_REQUEST_ERROR">HTTP_REQUEST_ERROR</a> : int = 404<div class="summaryTableDescription">[static] The requested service is temporarily unavailable.</div>
</td><td class="summaryTableOwnerCol">XdriveAPIError</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#INTERNAL_SERVER_ERROR">INTERNAL_SERVER_ERROR</a> : int = 0<div class="summaryTableDescription">[static] The requested service is temporarily unavailable.</div>
</td><td class="summaryTableOwnerCol">XdriveAPIError</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#INVALID_LOGIN_ERROR">INVALID_LOGIN_ERROR</a> : int = 501<div class="summaryTableDescription">[static] The login details or auth token passed were invalid.</div>
</td><td class="summaryTableOwnerCol">XdriveAPIError</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#METHOD_NOT_SUPPORTED">METHOD_NOT_SUPPORTED</a> : int = 90001<div class="summaryTableDescription">[static] The method type was not supported.</div>
</td><td class="summaryTableOwnerCol">XdriveAPIError</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#SHOW_PERMISSION_ERROR">SHOW_PERMISSION_ERROR</a> : int = 352<div class="summaryTableDescription">[static] The user does not have permissioin to edit a show.</div>
</td><td class="summaryTableOwnerCol">XdriveAPIError</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#UPLOAD_FILE_ERROR">UPLOAD_FILE_ERROR</a> : int = 3302<div class="summaryTableDescription">[static] Error occured during file upload </div>
</td><td class="summaryTableOwnerCol">XdriveAPIError</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="errorCode"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">errorCode</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>errorCode:int</code>&nbsp;&nbsp;[read-write]<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get errorCode():int</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set errorCode(value:int):void</code>
<br>
</div>
<a name="errorMessage"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">errorMessage</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>errorMessage:String</code>&nbsp;&nbsp;[read-write]<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get errorMessage():String</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set errorMessage(value:String):void</code>
<br>
</div>
<a name="JSON_EXCECTPION"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">JSON_EXCECTPION</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static var JSON_EXCECTPION:String = "exceptions"</code><p> JSON exception found on return call </p></div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="XdriveAPIError()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">XdriveAPIError</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function XdriveAPIError()</code>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="getErrorMessage()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getErrorMessage</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public static function getErrorMessage(errorCode:Number):String</code><p>
   Returns error message by errror number.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">errorCode</span>:Number</code> &mdash; The number of the error code.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code> &mdash; String The error message.
   </td>
</tr>
</table>
</div>
<a name="constantDetail"></a>
<div class="detailSectionHeader">Constant detail</div>
<a name="EXEEDED_COPIES_ERROR"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">EXEEDED_COPIES_ERROR</td><td class="detailHeaderType">constant</td>
</tr>
</table>
<div class="detailBody">
<code>public static const EXEEDED_COPIES_ERROR:int = 379</code><p> The requested service is temporarily unavailable. </p></div>
<a name="FOLDER_PERMISSION_ERROR"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">FOLDER_PERMISSION_ERROR</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const FOLDER_PERMISSION_ERROR:int = 364</code><p> User does not have permission to edit a folder. </p></div>
<a name="GENERIC_DATABASE_ERROR"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">GENERIC_DATABASE_ERROR</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const GENERIC_DATABASE_ERROR:int = 100</code><p> Generic database error, error in database call. </p></div>
<a name="HTTP_REQUEST_ERROR"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">HTTP_REQUEST_ERROR</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const HTTP_REQUEST_ERROR:int = 404</code><p> The requested service is temporarily unavailable. </p></div>
<a name="INTERNAL_SERVER_ERROR"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">INTERNAL_SERVER_ERROR</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const INTERNAL_SERVER_ERROR:int = 0</code><p> The requested service is temporarily unavailable.  </p></div>
<a name="INVALID_LOGIN_ERROR"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">INVALID_LOGIN_ERROR</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const INVALID_LOGIN_ERROR:int = 501</code><p> The login details or auth token passed were invalid. </p></div>
<a name="METHOD_NOT_SUPPORTED"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">METHOD_NOT_SUPPORTED</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const METHOD_NOT_SUPPORTED:int = 90001</code><p> The method type was not supported. </p></div>
<a name="SHOW_PERMISSION_ERROR"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">SHOW_PERMISSION_ERROR</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const SHOW_PERMISSION_ERROR:int = 352</code><p> The user does not have permissioin to edit a show. </p></div>
<a name="UPLOAD_FILE_ERROR"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">UPLOAD_FILE_ERROR</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const UPLOAD_FILE_ERROR:int = 3302</code><p> Error occured during file upload </p></div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
